Repository navigation
feat(ui): export evaluation reports with Nitro - #45
Merged
Merged
Conversation
Deploy to Cloudflare Workers (Preview) for docs ready.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #44.
Publish completed evaluations as a read-only Viewer site. Reviewers can open a link to a run, case, or comparison and inspect results and evidence from a static HTTP host. Nitro prerenders report data and copies the existing Viewer assets.
CLI changes
vieval report export .vieval/reports --output report-site@vieval/uifrom this revision alongsidevieval, use Node.js 22.22 or later to export, and serve the output directory over HTTP.vieval report export .vieval/reports --output report-siteWith no report roots, the command reads
.vieval/reportsfrom the current directory or next to--config <path>. Use a new output directory. Repeat--run <runKey>to limit the export to specific completed runs. Run attachments are included by default.--include-evidenceincludes linked external evidence, and repeatable--evidence-root <dir>adds allowed evidence directories.The command prints the count and destination followed by the omitted-file count. Example from the CLI smoke test, with the temporary directory abbreviated:
Vieval CLI dispatch · Export command
Report file and viewer API changes
No report file or viewer API changes. Existing run files and HTTP routes keep their contracts. Static export adds a separate site directory.
index.html,report/catalog.json(version 1), per-run data inreport/run/<index>.jsonandreport/comparison/<index>.json, optional raw telemetry underreport/otel/, and copied files underfiles/Static file layout · Viewer HTTP contract
Package exports
@vieval/uiexportReport({ reportRoots: ['.vieval/reports'], output: 'report-site' })returns{ omittedFiles, output, runKeys }vieval/cliimport type { ExportReportOptions, ExportReportResult } from 'vieval/cli'.ViewerModulegains an optionalexportReportmethod.vieval/clihelperimportViewer(baseDirectory, packageName?)importViewer(baseDirectory, packageName?, command?), with'--with-viewer'as the default command label for a missing packageNo public APIs were removed and no migration is required. Viewer entry point · New CLI types · Previous helper · Updated helper
Validation
pnpm run build:packages,pnpm typecheck, andpnpm lintpassed. Lint reported two existing warnings.pnpm test:runpassed all 717 tests across 89 files. Export integration testsBase
cf36c69063ede7ccbd64fc863679159ba1782d1f. Head76b23c5f57d00e29726c532a7fb9964a1ce134d4.